Vcenter Host Hardware DirectPathDevices Info

The name Vcenter Host Hardware DirectPathDevices Info schema describes a DirectPath device.

This schema was added in vSphere API 9.1.0.0.

JSON Example

{
    "name": "string",
    "current_mode": "string",
    "configurable_modes": [
        "string"
    ],
    "interconnect_type": "string",
    "driver_name": "string",
    "driver_version": "string",
    "memory_info": {
        "used_memory": 0,
        "total_memory": 0,
        "reserved_used_memory": 0,
        "total_reserved_memory": 0
    },
    "vms": [
        "string"
    ],
    "vm_classes_info": [
        {
            "zone": "string",
            "zone_name": "string",
            "vm_class": "string",
            "dpp_id": "string",
            "vm_class_reserved_in_use": 0,
            "vm_class_reserved_total": 0
        }
    ],
    "direct_path_profiles": [
        "string"
    ]
}

string

name

Required

The device name of this DirectPath device.

This property was added in vSphere API 9.1.0.0.

string

current_mode

Required

The current mode of the device.

For more information see: Vcenter Host Hardware DirectPathDevices DirectPathDeviceMode.

This property was added in vSphere API 9.1.0.0.

array of string

configurable_modes

Required

The valid modes this device can be configured to.

For more information see: Vcenter Host Hardware DirectPathDevices DirectPathDeviceMode.

This property was added in vSphere API 9.1.0.0.

string

interconnect_type

Optional

The interconnect type of the device.

This property was added in vSphere API 9.1.0.0.

if missing or null, then this information is not available.

string

driver_name

Optional

The driver name.

This property was added in vSphere API 9.1.0.0.

if missing or null, then this information is not available.

string

driver_version

Optional

The driver version.

This property was added in vSphere API 9.1.0.0.

if missing or null, then this information is not available.

memory_info

Optional

Information about device memory, if supported.

This property was added in vSphere API 9.1.0.0.

if missing or null, then this information is not available.

array of string

vms

Optional

Information about virtual machines using resources from this device.

This property was added in vSphere API 9.1.0.0.

if missing or null, then this information is not available.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: VirtualMachine. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: VirtualMachine.

array of Vcenter Host Hardware DirectPathDevices VmClassInfo

vm_classes_info

Optional

Information about VirtualMachineClasses using resources from this device.

This property was added in vSphere API 9.1.0.0.

if missing or null, then this information is not available.

array of string

direct_path_profiles

Optional

Information about DirectPathProfiles using resources from this device.

This property was added in vSphere API 9.1.0.0.

if missing or null, then this information is not available.